docs: read-cache-after-write consistency and event filtering#3193
docs: read-cache-after-write consistency and event filtering#3193
Conversation
There was a problem hiding this comment.
Pull request overview
Adds documentation describing the framework’s read-cache-after-write consistency guarantees and event filtering behavior introduced in v5.3.0, and links that information from the informer cache documentation.
Changes:
- Added a new “Read-cache-after-write consistency and event filtering” section to the reconciler documentation (including examples and caveats).
- Added a cross-link from the “working with event-source caches” documentation to the new reconciler section.
- Edited the “Expectations” section wording for clarity.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
docs/content/en/docs/documentation/working-with-es-caches.md |
Adds a short section linking readers to the reconciler docs for stronger consistency and event filtering. |
docs/content/en/docs/documentation/reconciler.md |
Documents the new read-cache-after-write consistency + event filtering behavior, updates expectations prose, and adds examples/caveats. |
Comments suppressed due to low confidence (1)
docs/content/en/docs/documentation/reconciler.md:194
makeStatusChanagesappears to be a typo (likely "makeStatusChanges"). Since this is documentation, keeping method names spelled correctly helps readers distinguish between framework API and placeholder code.
makeStatusChanages(webPage);
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
b2bc9ca to
53bec13
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (4)
docs/content/en/docs/documentation/reconciler.md:202
- Grammar issue: “
UpdateControlandErrorStatusUpdateControlby default uses” should be plural (“use”) to match the compound subject.
`UpdateControl` and `ErrorStatusUpdateControl` by default uses this functionality.
docs/content/en/docs/documentation/reconciler.md:233
- The caveat sentence is missing a subject: “However won't work with
InformerEventSource.list(..)...” should read “However, it won't work ...” to be grammatically correct and clearer.
methods. However won't work with `InformerEventSource.list(..)` method, since it directly reads
the underlying informer cache.
docs/content/en/docs/documentation/reconciler.md:238
- The bullet “Talk about this feature in this talk” is ungrammatical and a bit unclear. Consider rephrasing (e.g., “This feature is discussed in this talk …”) to improve readability.
- Talk about this feature in this [talk](https://www.youtube.com/watch?v=HrwHh5Yh6AM&t=1387s).
- [Umbrella issue](https://github.com/operator-framework/java-operator-sdk/issues/2944) on our GitHub.
docs/content/en/docs/documentation/working-with-es-caches.md:224
- This sentence is a run-on and is missing a comma after the introductory clause (“From version 5.3.0 …”). Consider splitting it into two sentences and/or adding the comma to improve readability.
From version 5.3.0 we provide stronger consistency guarantees and
other features on top of basic informers, see [this section](reconciler.md#read-cache-after-write-consistency-and-event-filtering)
for details.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
5fbba8c to
0cc6524
Compare
| [Attila Mészáros](https://github.com/csviri) and [Chris Laprun](https://github.com/metacosm) | ||
| --- | ||
|
|
||
| {{% alert title="Deprecated" %}} |
There was a problem hiding this comment.
Not sure about this: this doesn't seem standard MD and I'm not sure we should be adding formatting instructions that only work with the current publishing mechanism, i.e. it should be possible to render the documentation correctly locally, just using any MD reader.
There was a problem hiding this comment.
That is not possible even now, like for exmaple the mermaid pics are not standard stuff. We use hugo + docsy, you need hugo to render the document anyways, and this is standard way in docsy; and mainly looks great :)
There was a problem hiding this comment.
There was a problem hiding this comment.
btw you can always just see the docs by running hugo serve in docs directory. Now works with latest hugo. So if you install hugo with brew it should work like a charm to see the result.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Martin Stefanko <xstefank122@gmail.com>
Signed-off-by: Chris Laprun <metacosm@gmail.com>
ded2b7f to
08184fa
Compare
No description provided.